eFAWATEERcom BANK API

(0 reviews)

Account Upload

URLs :

Environment	Method	URL
Mock	PUT	https://eu1.anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/4be2e19f-42da-4571-80fd-19077a31ce58/efawateercom-bank-exp-api/1.0.7/m/account-upload
Dev	PUT	https://maictrldev.capitalbank.jo/efawateercom-bank-api/v1/account-upload
Stage	PUT	https://maictrlstg.capitalbank.jo/efawateercom-bank-api/v1/account-upload
Prod	PUT	To be updated

Description : This service allows the channels or bank to upload a customer profile to manage all accounts (Customer Profiles) and Billing Accounts in eFAWATEERcom system.

Channels that need to upsert the customer profile to the eFAWATEERcom system will send account upload request with the mandatory fields mentioned in the request format and in return eFAWATEERcom will provide a unique identification number joebppsNo for the customer’s ‘idType’, ‘id’, ‘nation’ combination. All new accounts are created in an 'Active' status. If already same account is present then remaining details passed will be updated for the same ‘idType’, ‘id’, ‘nation’ combination. Currently, eFAWATEERcom does not allow bulks for Account Upload service.

Mulesoft Request:

Mandatory Headers: x-channel-id,x-client-trace-id, x-bank-id,client_id, client_secret

Optional Headers: x-sub-channel-id, x-user-id, Authorization, x-debug-flag, x-customer-id

Request Body: Application/json

Field Name	Type	Length	Occurrence	Description	Validation
accts	Object		M
acct	Array		C		repeatable
idType	Enum, String	3	M	Represents a unique identifier type (The official number used to identify a customer)	Enum: NAT PAS IQA BIS GOV NGO DPC
id	string	20	M
nation	Enum, String	2	M	Represents the nationality of the Customer	Enum: JO - Jordanian IQ - Iraq GB - British KW - Kuwait
name	string	50	M
phone	string	20	O
address	string	100	O
email	string	50	O
End of ‘ acct ‘
End of ‘ accts ‘

{
"accts": {
"acct": [
{
"idType": "NAT",
"id": "9901001703",
"nation": "JO",
"name": "Ibrahim",
"phone": "+962786665356",
"address": "Amman",
"email": "ihamed@example.com"
}
]
}
}

Mulesoft Response:

Success Response: (200)

Response Body: application/json

Field Name	Type	Length	Occurrence	Description	Validation
status	Object		M
success	Boolean		M	true false
code	String	10	M	Error Code	“0” incase of success or Error Code
reasonCode	String	50	O	Error Type or Error category	Add this tag only incase of error
arabicMessage	String	200	M	English message translated to Arabic	تمت العملية بنجاح in case of success or arabic translated error in case of known errors
englishMessage	String	200	M	Description about the processing	“The Operation has been Successfully Completed” Or error Description
End of status
response	Object		O		Present if success = true
Acct	Object		M		repeatable
IdType	string	3	M
Id	string	20	M
Nation	char	2	M
Result	Object		M
ErrorCode	string	3	M
errorDesc	string	100	M
severity	Enum, String	7	M		Enum: Error, Info
End of result
joebppsNo	Integer	10	M
End of acct
End of accts
End of ‘ response ‘

{
"status": {
"success": true,
"code": "200",
"arabicMessage": "تمت العملية بنجاح",
"englishMessage": "The Operation has been Successfully Completed"
},
"response": {
"accts": {
"acct": [
{
"idType": "NAT",
"id": "9901001703",
"nation": "JO",
"result": {
"errorCode": "0",
"errorDesc": "Success",
"severity": "Info"
},
"joebppsNo": "29"
}
]
}
}
}

Sample Error Response:

Error codes :

500:

content-type: JSON

{
"success": false,
"code": "500",
"reasonCode": "InternalServerError",
"arabicMessage": "خطأ في الخادم الداخلي",
"englishMessage": "InvalidXMLSchema\nError : The 'Phone' element has an invalid value according to its data type.   Location : Line No:17, Line Position:24"
}

Account Upload

Reviews